package com.zy.explore.license.interfaces.feign.base;

import com.zy.explore.license.interfaces.frm.CommonIdFrm;
import com.zy.explore.license.interfaces.frm.CommonIdsFrm;
import com.zy.explore.license.interfaces.vo.PageVO;
import com.zy.explore.license.interfaces.frm.ExampleSaveFrm;
import com.zy.explore.license.interfaces.frm.ExampleQueryFrm;
import com.zy.explore.license.interfaces.vo.ExampleVO;
import com.zy.explore.license.infrastructure.constant.ProjectConstant;
import com.zy.explore.license.infrastructure.constant.Router;
import com.zy.explore.license.infrastructure.constant.ExampleRouter;

import org.springframework.cloud.openfeign.FeignClient;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.validation.annotation.Validated;
import java.util.List;

/**
 * description Jpa示例Feign
 *
 * @author 🇨🇳中国印🇨🇳
 * @date 2022年04月17日 02:36:49
 */
@FeignClient(value = ProjectConstant.APPLICATION_NAME, path = ExampleRouter.JPA_EXAMPLE_ROUTER, contextId = ProjectConstant.APPLICATION_NAME + ".JpaExampleFeign")
public interface JpaExampleFeign {

    /**
     * 新增数据
     *
     * @param frm 待新增的frm对象
     * @return 成功返回新增后的VO对象，失败返回null
     */
    @ApiOperation("①新增数据")
    @PostMapping(Router.INSERT)
    ExampleVO insert(@RequestBody @Validated ExampleSaveFrm frm);

    /**
     * 删除数据
     *
     * @param frm 主键frm对象
     * @return 1:删除成功 其他:删除失败
     */
    @ApiOperation("②删除数据")
    @PostMapping(Router.DELETE)
    Integer delete(@RequestBody @Validated CommonIdFrm frm);

    /**
     * 更新数据
     *
     * @param frm 待更新的frm对象
     * @return 成功返回更新后的VO对象，失败返回null
     */
    @ApiOperation("③更新数据")
    @PostMapping(Router.UPDATE)
    ExampleVO update(@RequestBody @Validated ExampleSaveFrm frm);

    /**
     * 通过主键查询单条数据
     *
     * @param frm 主键Frm对象
     * @return 成功返回对应ID的VO对象，失败返回null
     */
    @ApiOperation("④根据主键查询数据")
    @PostMapping(Router.FIND_BY_ID)
    ExampleVO findById(@RequestBody @Validated CommonIdFrm frm);

    /**
     * 通过主键批量查询数据集合
     *
     * @param frm 主键集合Frm对象
     * @return 成功返回对应ID的VO对象，失败返回空集合
     */
     @ApiOperation("⑤根据主键集批量查询数据")
     @PostMapping(Router.FIND_BY_IDS)
     List<ExampleVO> findByIds(@RequestBody @Validated CommonIdsFrm frm);

    /**
     * 根据条件获取数据集
     *
     * @param frm 查询条件对象
     * @return 成功返回满足条件的数据集合，失败返回空集合
     */
    @ApiOperation("⑥根据条件查询数据集")
    @PostMapping(Router.FIND_LIST)
    List<ExampleVO> findList(@RequestBody @Validated ExampleQueryFrm frm);

    /**
     * 根据条件查询数据分页
     *
     * @param frm 查询条件参数
     * @return 成功返回满足条件的分页，失败返回空页
     */
    @ApiOperation("⑦根据条件查询数据分页")
    @PostMapping(Router.FIND_PAGE)
    PageVO<ExampleVO> findPage(@RequestBody @Validated ExampleQueryFrm frm);

}
